home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / INPUT / PRESSABL.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.1 KB  |  59 lines
  1.  
  2. package sub_arctic.input;
  3.  
  4. /** 
  5.  * Input protocol interface for objects which wish to receive single mouse
  6.  * button down (press) and up (release) events.  This input protocol is 
  7.  * managed by the click_agent.  See click_agent for a discussion of the 
  8.  * interaction between this protocol, click, and double-click.
  9.  *
  10.  * @see sub_arctic.input.click_agent
  11.  * @author Scott Hudson
  12.  */
  13. public interface pressable {
  14.  
  15.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  16.  
  17.   /** 
  18.    * Dispatch mouse button press input to the object.  
  19.    * 
  20.    * @param event  evt       the event for the press.
  21.    * @param Object user_info the user information that was associated with 
  22.    *                         the pick used to dispatch this input to this 
  23.    *                         object.
  24.    * @return boolean indicating if the event was consumed.
  25.    */
  26.   public boolean press(event evt, Object user_info);
  27.  
  28.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  29.  
  30.   /**
  31.    * Dispatch mouse button release input to the object.  
  32.    * 
  33.    * @param event  evt       the event for the release.
  34.    * @param Object user_info the user information that was associated with 
  35.    *                         the pick used to dispatch this input to this 
  36.    *                         object.
  37.    * @return boolean indicating if the event was consumed.
  38.    */
  39.   public boolean release(event evt, Object user_info);
  40.  
  41.   /* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . */
  42. }
  43. /*=========================== COPYRIGHT NOTICE ===========================
  44.  
  45. This file is part of the subArctic user interface toolkit.
  46.  
  47. Copyright (c) 1996 Scott Hudson and Ian Smith
  48. All rights reserved.
  49.  
  50. The subArctic system is freely available for most uses under the terms
  51. and conditions described in 
  52.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  53. and appearing in full in the lib/interactor.java source file.
  54.  
  55. The current release and additional information about this software can be 
  56. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  57.  
  58. ========================================================================*/
  59.